本文档介绍 A1 平台与钉钉(DingTalk)集成的相关接口函数及参数定义,适用于自动化消息推送和任务管理等场景。
一、ding_talk_send_message
功能说明
通过钉钉机器人发送群消息,支持多种消息类型和模板。
输入参数
| 参数名 | 类型 | 必填 | 说明 |
|---|
api_key | String | * | 钉钉机器人的 AppKey,用于获取访问令牌 |
app_secret | String | * | 钉钉机器人的 AppSecret,用于获取访问令牌 |
msg_param | String | * | 消息内容参数,包含消息正文的字符串 |
msg_key | String | * | 消息模板键名,指定要发送的消息类型 |
robot_code | String | - | 机器人编码,用于标识特定的机器人 |
输出参数
| 参数名 | 类型 | 说明 |
|---|
processQueryKey | String | 钉钉 API 返回的查询键,可用于后续查询消息处理状态 |
二、dingtalk_task_detail
功能说明
获取钉钉任务的详细信息,支持按用户和任务维度查询。
输入参数
| 参数名 | 类型 | 必填 | 说明 |
|---|
api_key | String | * | 用于认证请求的钉钉 API 访问令牌 |
user_id | String | * | 用户 ID,指定任务所属的用户 |
task_id | String | - | 任务 ID,用于查询特定任务的详细信息 |
输出参数
| 参数名 | 类型 | 说明 |
|---|
result | String | 钉钉接口响应结果,包含任务的详细信息 |
三、dingtalk_create_task
功能说明
在钉钉平台创建任务,支持项目关联和执行人分配。
输入参数
| 参数名 | 类型 | 必填 | 说明 |
|---|
api_key | String | * | 用于认证请求的钉钉 API 访问令牌 |
user_id | String | * | 用户 ID,指定任务创建者 |
project_id | String | * | 项目 ID,表示任务所属的项目 |
content | String | * | 任务内容描述 |
executor_id | String | - | 执行人 ID,指定任务的执行者 |
Note | String | - | 任务备注信息 |
输出参数
| 参数名 | 类型 | 说明 |
|---|
result | String | 钉钉接口响应结果,返回任务创建状态或相关信息 |
四、使用示例
4.1 发送群消息流程
4.2 创建任务流程
4.3 查询任务详情流程
4.4 完整业务场景
五、注意事项
| 项目 | 说明 |
|---|
| 认证凭据 | api_key 和 app_secret 需在钉钉开放平台申请 |
| 权限范围 | 确保机器人具备发送消息和创建任务的权限 |
| 参数格式 | msg_param 应符合钉钉消息格式规范 |
| 错误处理 | 建议对接口返回结果进行异常捕获和处理 |
六、参数说明